Skip to content

docs: fix link and wrap grammar examples in SPEC#40

Merged
johannschopplich merged 5 commits intotoon-format:mainfrom
milanjaros:main
Apr 1, 2026
Merged

docs: fix link and wrap grammar examples in SPEC#40
johannschopplich merged 5 commits intotoon-format:mainfrom
milanjaros:main

Conversation

@milanjaros
Copy link
Copy Markdown
Contributor

@milanjaros milanjaros commented Mar 23, 2026

Description

Fix broken markdown links and normalize array grammar examples.

Type of Change

  • 📝 Clarification (typo fix, grammar improvement, clarifying language)
  • 📚 Documentation (adding examples, improving structure)
  • ✨ Minor change (backward-compatible addition or clarification)
  • 🔥 Major change (breaking change, new syntax, conformance requirement change)
  • 🧪 Test fixtures (adding or updating test cases)
  • 🔧 Other (please describe):

Motivation and Context

  • Fix not working link in the TOC in SPEC because it does not work
  • I noticed strange example
image
  • once fixed by wrapping by "`" I wrapped other grammar examples in the Arrays section
  • Indentation of bullet list in Appendix 6 section was performed by IDE, it is not necessary

Changes Made

  • Fix not working link in the TOC in SPEC
  • Wrap grammar examples in the Arrays section by "`"
  • Indentation of bullet list in Delimiters section was performed by IDE, it is not necessary

Specification Sections Affected

Documentation and style changes only:

  • Section 9: Arrays
  • Section 10: Objects as List Items
  • Section 11: Delimiters
  • Appendix G.5: General Guidance

Backward Compatibility

  • ✅ Fully backward-compatible (no breaking changes)
  • ⚠️ Potentially breaking (requires careful review)
  • 💥 Breaking change (requires major version bump)

Impact on Existing Implementations

No impact.

Examples

N/A

Before

N/A

After

N/A

Test Coverage

  • Existing test fixtures pass
  • New test fixtures added (if applicable)
  • Examples in SPEC.md updated
  • Reference implementation behavior documented

Documentation

  • SPEC.md updated
  • CHANGELOG.md updated
  • Examples updated (if applicable)
  • README.md updated (if applicable)
  • Test fixtures updated (if applicable)

Checklist

  • I have read CONTRIBUTING.md
  • I have searched for similar PRs and issues
  • My changes follow the specification writing style guidelines
  • I have used RFC 2119 keywords (MUST, SHOULD, MAY) correctly where applicable
  • I have provided clear examples
  • I have updated CHANGELOG.md with my changes
  • I have considered the impact on existing implementations
  • For breaking changes: I have provided a migration strategy
  • All new and existing tests pass

Additional Notes


For Maintainers:

  • Version number assigned (if needed)
  • Spec version updated (if applicable)
  • Breaking change documented in VERSIONING.md (if applicable)
  • Community implementations notified (if breaking change)

@johannschopplich
Copy link
Copy Markdown
Contributor

Hi @milanjaros, thanks for the PR – the link fix and backtick wrapping are good catches.

One issue: in the Section 9.3 tabular header line, the closing } was dropped. The original reads key[N<delim?>]{f1<delim>f2<delim>…}: but your change has key[N<delim?>]{f1<delim>f2<delim>…: – missing the closing brace before the colon.

Could you fix that? Happy to merge once it's corrected.

@milanjaros
Copy link
Copy Markdown
Contributor Author

Corrected. I wish I had eyes as sharp as yours. 😇

@johannschopplich johannschopplich merged commit f25d8a2 into toon-format:main Apr 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants